home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_1
/
hyper18.zip
/
HYPER18.DOC
< prev
next >
Wrap
Text File
|
1991-05-12
|
52KB
|
1,717 lines
█ █ █▀▄ ▄▀█ ▀ █
█▄▄▄▄█ █ █ █▀▀▀▀█ █▀▀▀▀▀█ █ ▄▀▀▀ █ █ █ ▀▀▀▀▀█ █ █
█ █ █ █ █ █ █▄▄▄▄▄█ █▀ █ █ █▀▀▀▀▀█ █ █
█ █ █▄▄▄▄█ █▄▄▄▄█ █▄▄▄▄▄ █ █ █ █▄▄▄▄▄█ █ █
█ █
▀▀▀▀ ▀
CMI HyperMail
Copyright (c) 1989, 1990 Code Masters, Inc.
Version 1.8 GR
!Shareware!
__________________________________________________________________________
HyperMail Documentation
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
Documentation Outline
1.0.0 Introduction
1.1.0 About the HyperMail concept
1.2.0 High level system overview
1.3.0 Maintenance and Housekeeping
2.0.0 Installation
2.1.0 Information required prior to installation
2.2.0 Where to put files
2.3.0 Running the install program
2.4.0 What install does
3.0.0 System Configuration Files
3.1.0 NETMAIL.CNF
3.2.0 Conference Request File
3.3.0 LOCK Files
4.0.0 Programs/Parameter Reference
4.1.0 System Programs
4.1.1 MSGUTIL.EXE
4.1.2 UPDATE.EXE
4.1.3 LINEMAN.EXE
4.1.4 MAKESYS.EXE
4.1.5 HUBUTIL.EXE
4.1.8 COMPLETE.EXE
4.1.9 NODECOMM.EXE
4.1.10 HUBCOMM.EXE
4.1.11 PACKAGE.EXE
4.1.12 READSYS.EXE
4.2.0 HyperMail Utility Programs
4.2.1 REWIND.EXE
4.2.2 DUMPMSG.EXE
4.2.3 DUMPSYS.EXE
4.2.4 TRIMCRC.EXE
4.2.5 Section Not Included
4.2.6 DELAY.EXE
4.2.7 REGISTER.EXE
4.2.8 STRIP.EXE
4.2.9 Section Not Included
4.2.10 INSTALL.EXE
4.3.0 WAM Format System Programs
4.3.1 NETUTIL.EXE
4.3.2 PCB2WAM.EXE
4.3.3 ADDCRC.EXE
5.0.0 System Batch File Reference
5.1.0 EV_NODE.BAT
5.2.0 EV_HUB.BAT
5.3.0 DC_NODE.BAT
5.4.0 DC_HUB.BAT
5.5.0 AC_HUB.BAT (AC_NODE1.BAT and AC_NODE2.BAT see Appendix D)
5.6.0 CALLSEND.BAT
5.7.0 BUILD.BAT
5.8.0 PACKET.BAT
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 1 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
6.0.0 System Control File Reference
6.1.0 NETMAIL.SYS
6.2.0 NETMAIL.LOG
6.3.0 $SYSTEM$.PWD
6.4.0 $EMAIL and $EMAIL.NDX
6.5.0 CRC and CRC.IX
6.6.0 SystemId.SYS
7.0.0 Environment Variables
7.1.0 LOGFILE=
7.2.0 SYSTEM=
7.3.0 CONFIG=
7.4.0 BAUD=
8.0.0 Required third party programs
8.1.0 DSZ
8.2.0 PKZIP
9.0.0 Conclusion
9.1.0 Registration Information
9.2.0 Disclaimer
9.3.0 Where to get more information
Appendix A - Example: Steps to set up a 3 node network.
Appendix B - Using PCBoard as a front end.
Appendix C - Upgrading from a previous version of HyperMail
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 2 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
1.0.0 Introduction
One of the increasingly popular avenues BBS enthusiasts are taking their
systems into is Electronic Mail Networks. As the popularity of these
networks increases, so does the variety of network products. Each network
software package has its own blend of distinguishing features designed by
its authors. The HyperMail Network System has been created with a variety
of unique features that deliver it to the cutting edge of BBS Electronic
Mail Networking. The HyperMail System is designed to be easy to install by
novice system operators and yet it packs state of the art features that
experienced system operators require.
The HyperMail Network System is configured to work with PCBoard 14.x
compatible messages bases. It is not required that your use PCBoard to run
HyperMail. Other software packages such as PassKey, WBBS and WildCat are
'interface-able' with HyperMail. Consult the Wide Area Message Format
section of the manual for more information. As translators become
available for more systems, HyperMail will grow to be a valued tool for
your networking needs.
The HyperMail Electronic Mail Network System provides the following
features:
* Easy to use installation tool
* Completely self contained communications modules (no
complicated and unreliable communications program scripts to
write)
* High speed message processing system
* CRC checking of all messages - Absolutely NO duplicate
messages!
* Optional suppression of TAG lines
* Shareware! No need to spend money before your network is
operational.
* Too many more features to mention...
1.1.0 About the HyperMail Concept
The installation tool provided in the HyperMail software package
will completely install and configure the HyperMail network system on
a Node in under 20 minutes (slightly less time is required for Hub
configuration). The HyperMail installation tool provides context sensitive
help and complete checking for all configuration information. When all of
the necessary information has been entered into the configuration utility,
the installation tool will create all necessary batch files and
configuration files, allowing the system operator to begin processing mail
after only a few more steps.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 3 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
One of the most unique features of the HyperMail software package is the
communications modules. HyperMail does not rely on complicated and
unreliable script files and confusing modem programs. The HUBComm and
NODEComm modules of HyperMail have been designed specifically to transfer
mail fast and reliably without requiring constant system operator
supervision.
Because of HyperMail's ease of installation and maintenance free operation,
the system operator is free to spend his time on other, more enjoyable
tasks. Thank you for selecting HyperMail as your network software of
choice.
1.2.0 High Level System Overview
Node:
The following describes the steps a HyperMail Node completes to transfer
mail with the Hub(s) it is attached to:
1> The Node software checks all HyperMail designated conferences for
outbound messages and extracts copies of them to a temporary file.
2> The Node then dials the phone number of its Hub. The Hub software
receiving the call picks up the phone and connection is established.
3> The Node and corresponding Hub exchange system Id and password
information. This step provides identification of individual nodes
and complete mail security.
4> The Node sends any outbound messages to the Hub system it is
currently attached to. It also transfers an updated list of message
areas the system is currently accepting messages for.
5> After receiving the message package from the node, the hub transfers
any messages addressed to the currently connected node.
6> All of the messages have been exchanged at this point, so the
communication link is disconnected.
7> The Node software processes any messages that it has received,
places them in their designated message areas and cleans up
remaining temporary files.
1.3.0 Maintenance and Housekeeping
2.0.0 Installation
A typical HyperMail software installation takes less than 20 minutes for a
novice user. If an error occurs during installation the process can be
repeated as necessary. Multiple installations will no affect system
performance.
2.1.0 Information required prior to installation
* System Id - Choose a System Id for the node. This can be any
combination of 8 numbers or letters. The System Id is used to
identify each individual HyperMail system for proper connection and
mail transfer. This System Id should be descriptive of the BBS.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 4 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
Because it is used to create DOS files, the system ID is limited to
characters that are valid in DOS file names.
* BBS Drive Letter and Directory Name - The DOS directory that contains
all of the software and configuration files for your BBS.
* Command Line used to start your BBS - The name of the batch file you
use to start your BBS (ie. BOARD.BAT).
* Type of Message Information file you will be using. As of vesion
1.72 of HyperMail, the system will support either the ProDoor
CONFINFO file format or the PCBoard 14.5 CNAMES.@@@ file format. If
you are running a PCBoard version less than 14.5 you must use a
ProDOOR CONFINFO file.
* The number of the communications port your modem is attached to (ie.
COM1 or COM2). Note: HyperMail only supports ComPorts 1 thru 2.
* What type of modem your have:
D - USR Dual Standard (Full duplex at V.32 9600);
H - Half Duplex at high speeds (HST HST1440 modes)
F - Full Duplex always (Standard 1200, 2400 modems)
* The maximum BPS rate your modem will accept - This is the highest
speed your modem is capable of using to communicate with the
computer. Note: This number must be 19200 or less if you do not have
a 16550 UART communications chip installed in your computer. The
installation utility will check for this and will not allow you to
use an improper value.
* The System ID of the HUB your system will be calling to exchange
mail (for Node configuration only) - Most systems attached to an
Electronic Mail Network need to place at least one phone call to
exchange mail. With HyperMail, this call must be placed to a system
running the HyperMail Software. Before you can properly exchange mail
with a HyperMail Hub, it is necessary to have its system id.
To obtain information regarding BBSs currently running HyperMail HUB
software, please see the WHERE TO GET MORE INFORMATION section of the
manual.
* The Phone Number of the HUB your system will be calling to exchange
mail (for Node configuration only).
2.2.0 Where to put the files
Once you have all of the information necessary to begin the installation,
you must create a DOS subdirectory on your hard disk specifically for the
use of HyperMail. Once this is done, copy all of the files included with
your HyperMail package into this directory.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 5 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
2.3.0 Running the Installation Tool
After creating a subdirectory for the HyperMail software and moving all of
the HyperMail files into it, it is necessary to run the Installation Tool.
Begin by changing the current directory to the newly created HyperMail
directory. Next type:
INSTALL
and press <RETURN> from the DOS prompt.
This will execute the Installation Tool and allow you to enter all of the
necessary information. The Installation program has built in context
sensitive help. You can press the <F1> key on your keyboard at any prompt
to see more information about the current question.
The installation program requires a system information file called
REGISTER.DOC. This file contains your registration information.
If this file is missing Install will not operate. If you know your
registration number and registration name, you can execute the REGISTER.EXE
program to create a REGISTER.DOC file.
2.4.0 What the Installation Tool does
The HyperMail Installation Tool performs a majority of the tasks necessary
for proper installation of the HyperMail Software Package. This includes:
* Creates all of the Batch files necessary for operation. All of
the batch files created are custom and base on information
entered in the Installation Tool.
* Writes the NETMAIL.CNF file. NETMAIL.CNF is the main
configuration file used by most of the programs in the HyperMail
system. This file is described in depth in the SYSTEM
CONFIGURATION FILES section of this manual.
* Runs the UPDATE utility. This utility creates a pointer file
that is used to reference your BBS message bases. This file must
be created before your system is able to properly process mail.
The UPDATE program is explained in depth in the SYSTEM PROGRAMS
REFERENCE section of this manual.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 6 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
3.0.0 System Configuration Files
3.1.0 NETMAIL.CNF
The NETMAIL.CNF file is the main configuration file. This file is used by
almost all of the programs included in the HyperMail software package.
This file is a text file and can be edited by most text editors (ie. DOS
EDLIN, QEdit, etc.). The following is an example NETMAIL.CNF file:
VERSION 1.71 ; Version Information
HyperLink Administration ; Registration Name
0000 ; Registration Number
NONE ; Comment on Messages
C:\PCB ; BBS System Directory
C:\PCB\MAIN\CNAMES.@@@ /CNAMES ; Path and Name of Conference File
1 ; Com Port
9600 ; Maximum BPS open rate
ATX4M0H0 ; Modem Init String
YES ; Echo Private Mail
ANDY WOODWARD ; Sysop Name
(602)888-8888 ; Voice Phone Number
(602)838-7738 ; Data Phone Number
1 Any Street ; Street Address
Phoenix ; City
AZ ; State
85000 ; ZipCode
0 ; Greenwich Mean Time Factor
; Node List Comment (60 chars max!)
This is a comment for the Node List.
Any information that appears after a semicolon in the NETMAIL.CNF file is
not used by the HyperMail System and may be used as comment areas.
The registration name and registration number are provided with your
original software package in a file called REGISTER.DOC. If you do not have
a REGISTER.DOC file but you know your registration name and number. You may
create a REGISTER.DOC file by using the REGISTER.EXE utility (included with
the HyperMail Software Package).
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 7 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
3.2.0 Conference Request File
Every node must create a conference request file. The conference request
file is used to request conferences from the attached hub. The request
file also specifies where these message areas are to be directed.
1> PASSWORD
2> 3 10
3> 7 6
4> 22 7
5> 9 8
6> 5 5
Line 1: Your Password for the Hub
Line 2: The conference conversions:
The left side lists the node conference numbers, the right
side is the Hubs conference numbers. You are
requesting the Hub conferences which will be placed
in your node conferences.
As in the example:
Hub Area 10 is directed to your area 3
Hub Area 6 is directed to your area 7
Hub Area 7 is directed to your area 22
Hub Area 8 is directed to your area 9
Hub Area 5 is directed to your area 5
There can be a maximum of 255 conference requests. Note: it is not possible
to direct messages from more than one conference into a specific
conference. The following example is not possible with HyperMail:
PASSWORD
5 6
22 6
Be sure and check your conference table to make sure this does not happen.
3.3.0 LOCK Files
For every node connected, the system operator can include in the
HyperMail directory a file named SystemId.LOK, where the SystemId is the
name of node attached to you. The *.LOK file is a text file in the format
of:
Cnum;Cnum;Cnum-Cnum;Cnum;Cnum-Cnum
where you specify conferences to 'Lock' in a sequence similar to how the
REWIND.EXE program functions.
The *.LOK files restrict a node's access to the conferences listed in the
SystemId.LOK file. A node may request a message base listed in his
SystemId.LOK file, but no messages will be extracted. The Lock function
does not affect insertion.
The Hub system operator may also create a file called _GLOBAL_.LOK, which
is another .LOK file, but is active for ALL nodes.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 8 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
NOTE: If an entry exists for a specific conference in a SystemId.LOK file
AND in the _GLOBAL_.LOK file the entry is toggled (i.e. that node will be
able to request that conference).
4.0.0 Programs/Parameter Reference
4.1.0 HyperMail System Programs
This section is a reference to the functionality and command line
parameters for the HyperMail System Programs.
4.1.1 MSGUTIL.EXE Parameters
Description: This program controls access to all message areas.
Parameters:
/EXTRACT - Extract new messages
/INSERT - Insert received messages
/BUILD - Build packets for nodes. This is only for hub operation. The
build operation extracts new messages for every node attached to the hub.
/DISABLE_OUTPUT - Do not write a NETMAIL.MSG file. This parameter is
only valid with use of the /EXTRACT parameter.
/ECHO - Echo ALL messages regardless of message echo flag. This
parameter is only valid with use of the /EXTRACT parameter. This
parameter is necessary other network programs turn off the message echo
flags.
/DAYS:NumDays - Limit inserted messages to NumDays. Messages that are
less than or equal to Numdays old will be inserted. This parameter is
only valid with use of the /INSERT parameter.
/NOSCREEN - Do not write verbose messages to the screen.
/DISABLELOG - Do not write logging information to the NETMAIL.LOG file.
It is not recommended that this parameter be used.
/NOTAG - Do not include HyperMail tag lines.
Notes:
Parameters may be in any order. /EXTRACT or /INSERT or /BUILD must be
present somewhere on the command line. The other parameters are not
required.
Example:
MSGUTIL.EXE /E /ECHO /NOSCREEN
This causes the program to operate in 'Extract' mode. MSGUTIL.EXE will
echo ALL messages regardless of the individual message echo flag and
will not write messages to the screen.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 9 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
4.1.2 UPDATE.EXE
Description: The UPDATE.EXE reads the NETMAIL.SYS file and updates the
pointer file (SystemId.PTR) bases on the remote system specified in the
NETMAIL.SYS file. UPDATE.EXE positions the message pointers to the high
message number of each message area and rewrites the (SystemId.PTR) file.
4.1.3 LINEMAN.EXE Parameter ComPort
Description: This program controls the data link between the remote and
the host systems.
Parameters:
H <- Hold the data link
R <- Release the data link
O <- Disconnect data link
Example:
LINEMAN 1 O
The datalink on com port 1 will be disconnected.
4.1.4 MAKESYS.EXE LocalId [RemoteId PhoneNumber] [Protocol] [Function]
Description: The program creates the system control file used by the
HyperMail system. The default name for the system control file is
NETMAIL.SYS. The default name can be changed by using an environment
variable. The control file holds general information used by most every
program in the system.
Parameters:
LocalId - Specify your system id, the 8 letter identifier that was
assigned to your system. For example: CIS or TECHNOID. This is the only
parameter needed if the local system is acting like a hub or receiving
calls.
The following parameters are required when the local system is attempting
to connect with a hub or place a call:
RemoteSystemId - Specify the remote id for which a session is to be
established.
PhoneNumber - Specify the phone number, including long distance codes if
any, for the remote system.
Protocol - This parameter selects the protocol for the transfer. This
parameter can be a letter from A to Z. If the parameter is not
specified, the default is Z for Zmodem. If a protocol is requested that
the hub system does not support, both systems will default to Zmodem.
Function - The function parameter specifies with function the systems
will perform. The value of the function parameter must be between 1 and
98. If no function is specified the default to 0 or normal mail
processing.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 10 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
Example:
MAKESYS.EXE CIS TECHNOID 1170,1-602-222-1234
This example creates a system file for use by the node 'CIS'. CIS will
be placing a call to TECHNOID. This will cause MAKESYS.EXE to create a
system file where the local system id is CIS, the remote system id is
TECHNOID and the remote phone number is 1170,1-602-222-1234. The
protocol will default to Zmodem. The function will default to 0 or
normal mail processing.
MAKESYS.EXE TECHNOID
This example creates a system file for use when system 'TECHNOID' is
acting like a hub or receiving calls.
4.1.5 HUBUTIL.EXE
Description: HubUtil contains a collection of functions used internally
by the HyperMail system. These parameters are provided as a reference
only.
Parameters:
/PASSWORD - Copies the SystemId.NEW to ConnectId.NOD
/NAME - Renames ConnectId.ZIP to NODE.ZIP
/RENAME - Renames NODE.ZIP to ConnectId.ZIP
/DELETE - Purges ConnectId.SYS
/EXTRACT - Renames NETMAIL.MSG to ConnectId.MSG
4.1.8 COMPLETE.EXE
Description: This program logs a completed mail transfer session to a log
file called COMPLETE.LOG.
4.1.9 NODECOMM.EXE TimeOutPeriod [Parameters]
Description: NODECOMM.EXE is the communications engine used by node
system for placing calls to hub systems. NodeComm is the counter part
for HubComm which runs on the hub system.
Parameters:
TimeOutPeriod - Numeric number between 5 and 999. Tells NODECOMM.EXE how
long to try to connect with the remote system in minutes.
/CD - Load on carrier detect (DO NOT hang-up) and do not initialize the
modem. Use the /CD parameter when a connection has already been
established by another program. NodeComm will not initialize the modem
or dial the remote system. This causes NodeComm to proceed to the system
password handshake phase.
/F:filename - Activate NodeComm for front-end processing. NodeComm will
read the first line in the filename and transmit that line every three
seconds for 15 seconds. This should allow a front end like ProLogon to
trigger a mail session. For example: ProLogon requires the string 'N
MAILRUN' to be transmitted in order to trigger a mail process. See
Appendix B for further information.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 11 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
4.1.10 HUBCOMM.EXE TimeOutPeriod [Parameters]
Description: NODECOMM.EXE is the communications engine used by hub system
to receive calls from node systems. HubComm is the counter part for
NodeComm which runs on the node system.
Parameters:
TimeOutPeriod - Numeric number between 5 and 999. This configures
HubComm to wait in answer mode for the TimeOutPeriod.
/CD - Load on carrier detect (DO NOT hang-up) or initialize the modem.
Use this parameter with a front end program and the AC_HUB.BAT file.
4.1.11 PACKAGE.EXE pkzip.exe $1$ $2$
Description: Package adds newly extracted mail packets to an
existing archive. The first parameter specifies the compression program
to use, normally PKZIP.EXE. The compression program MUST exist on the
DOS path not in the current directory. If the path statement is SET
PATH=C:\TOOLS then PKZIP.EXE must reside in the directory C:\TOOLS.
The second parameter $1$ is the archive name. The Third parameter $2$ is
the file to be added to the archive. Package shells to the compression
program and passes the proper parameters by using the $1$ and $2$ for
placement. Other parameters may be passed. Both $1$ and $2$ are
required to exist on the command line or Package will not function
properly.
Parameters:
pkzip.exe - the compression program to use. pkzip.exe is the default
used by the system. This parameter may be replaced by other compression
utilities as they become available. NOTE: All systems using HyperMail
must maintain the same compression standard. Do not change this
parameter unless directed by the network administrator.
$1$ - This parameter is replaced by the archive name by Package.
$2$ - This parameter is replaced by the file name to be added to the
archive.
Notes:
DO NOT change the parameters to any command line used by PACKAGE.EXE
unless directed by the network administrator.
Example:
PACKAGE pkzip.exe -a $1$ $2$ extra.doc nodelist.doc
Package with shell to PKZIP.EXE using the command line:
PKZIP.EXE -A ArchiveName FileToAdd EXTRA.DOC NODELIST.DOC
ArchiveName and FileToAdd will be replaced by Package with the proper
parameters. This command line causes PKZIP.EXE to add to the archive
specified by ArchiveName the files FileToAdd, EXTRA.DOC NODELIST.DOC.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 12 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
4.1.12 READSYS.EXE
Description: This program controls batch file execution inside the
HyperMail system.
Parameters:
/FUNCTION - Causes ReadSys to halt on an errorlevel corresponding to the
function parameter in the system control file (NETMAIL.SYS).
/PROTOCOL - Causes ReadSys to halt on an errorlevel corresponding to the
protocol parameter in the system control file (NETMAIL.SYS).
Example:
READSYS.EXE /FUNCTION
IF ERRORLEVEL 9 GOTO FUNCTION_9
IF ERRORLEVLE 8 GOTO FUNCTION_8
READSYS.EXE /PROTOCOL
IF ERRORLEVEL 26 GOTO ZMODEM_TRANSFER ( Z is 26th letter in
alphabet) IF ERRORLEVEL 7 GOTO YMODEM_G_TRANSFER ( G is 7th letter in
alphabet)
4.2.0 HyperMail User Utility Programs
4.2.1 REWIND.EXE SystemId AreaList NumberOfMessages
Description: This program allows system operators to rewind the message
pointer for a particular message area or a list of messages areas.
Parameters:
SystemId - The active pointer file for a system.
AreaList - Specifies a list of conferences or a range of conferences to
be rewound. A semicolon ';' is an area separator and a '-' is a range
indicator. For example: 1-5;8;10;12-15 would rewind messages areas
1,2,3,4,5,8,10,12,13,14,15.
NumberOfMessages - Specifies how many messages to rewind. If this value
is larger than the available message count, the message area in the
pointer file is rewound to the first message.
4.2.2 DUMPMSG.EXE MessageFileName
Description: Creates a text file bases on the MessagefileName. The name
of the text file is MESSAGES.OUT.
Parameters:
MessageFileName - This is the message base to 'dump' to a text file. It
can be a HyperMail packet file (NEMTAIL.MSG MP??????.PKT) or a ProDOOR
compatible message base.
4.2.3 DUMPSYS.EXE
Description: Displays the contents of the current system control file.
Usually this file is named NETMAIL.SYS unless otherwise overridden by an
environment variable.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 13 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
4.2.4 TRIMCRC.EXE NumberToKeep
Description: The HyperMail system maintains a CRC data base for all
inserted and extracted messages for the local system. On occasion it may
be necessary to purge older records from this data base as it may be
large. Executing TRIMCRC.EXE with no parameters will show the number of
records currently stored in the data base.
Parameters:
NumberToKeep - Specifies the number of message CRC's to keep. The system
will keep the most recent records and purge all old records above the
NumberToKeep threshold.
4.2.5 Section Not Included
4.2.6 DELAY.EXE NumberOfSeconds
Description: Causes a count down to take place.
Parameters:
NumberOfSeconds - Number of seconds to count.
Example:
DELAY 8
Delay 8 seconds.
4.2.7 REGISTER.EXE
Description: Creates a REGISTER.DOC file required by INSTALL.EXE. Given
the system name text and a serial number, Register will create a
REGISTER.DOC file for the install program.
4.2.8 STRIP.EXE FileSpec [/C] [/T:FileName] [/Text]
Description: Strip is a general purpose utility to strip control
characters (ASCII 1 to ASCII 31) and tag files from ProDOOR compatible
message bases, HyperMail message files or text files.
Parameters:
FileSpec - Specifies a file name (wild cards ok) to process. For
example: STRIP.EXE *.PKT /C would strip all control characters for all
.PKT files in the current directory.
/C - Strip control characters from message files. This parameter will
strip any character between ASCII decimal 1 and ASCII decimal 31.
/T:filename - Causes Strip to read filename into a buffer area and search
for tag lines based on the filename entries.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 14 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
filename format - specify a tag file to purge, this is case sensitive!
For example:
* Via
* EZ
would strip all lines beginning with "* Via" and "* EZ". Leading
spaces are stripped from both the message text and the tag file
entries.
Notes: An example tag file called TAGFILE.TXT is included in the
HyperMail package for further examples.
4.2.9 Section Not Included
4.2.10 INSTALL.EXE
Description: Asks a series of questions and creates the appropriate
configuration files and batch files for system operation. The operation
of the system is not affected by multiple installations.
4.3.0 WAM Format System Programs
These utilities are only used when the HyperMail system is configured
with a WAM interface. Using a WAM interface allows any system to
communicate to a HyperMail network. As more interfaces become available
for such systems as FIDO, WildCat, QBBS, WBBS and PassKey, these systems
will be able to interface with ANY HyperMail network.
The WAM Format is a general purpose textual interface standard for
message interchange. The format is released every quarter with changes
and updates. Consult the file WAM?Q90.ZIP for more information on the
WAM Format.
Consult HYPERWAM.ZIP for more information on how to interface HyperMail
to WAM and ANY BBS to WAM.
4.3.1 NETUTIL.EXE
Description: This program is the control center for the HyperWam
interface. It executes WAM interface files EXPORT.EXE, IMPORT.EXE and
UPDATE.EXE in the proper sequence.
4.3.2 PCB2WAM.EXE
Description: This program converts ProDOOR compatible message bases or
HyperMail message files to the WAM Format standard and visa versa.
Execute the program to review the command line parameters.
4.3.3 ADDCRC.EXE
Description: AddCRC is a utility for the HyperWam interface that adds
CRC's to the CRC data base maintained by the HyperMail system. Consult
HyperWam documentation for further reference.
5.0.0 System Batch File Reference
5.1.0 EV_NODE.BAT
Description: This batch file is a replacement for an event file for the
node system. EV_NODE will change to the mail directory as specified by
INSTALL.EXE, conduct a mail run, change back to the BBS directory and
restart the BBS. EV_NODE.BAT is for use on Node systems and should be
added to or combined with the current event file.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 15 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
5.2.0 EV_HUB.BAT
Description: This batch file is a replacement for an event file for the
hub system. EV_HUB will change to the mail directory as specified by
INSTALL.EXE, conduct a mail run, change back to the BBS directory and
restart the bbs. EV_HUB.BAT is for use on Hub systems and should be
added to or combined with the current event file.
5.3.0 DC_NODE.BAT
Description: This batch file is the workhorse of the HyperMail system
for node operation. It requires several parameters. EV_NODE.BAT calls
this batch file with the proper parameters. Consult the batch file
listing for further information.
5.4.0 DC_HUB.BAT
Description: This batch file is the workhorse of the HyperMail system
for hub operation. It requires several parameters. EV_HUB.BAT calls
this batch file with the proper parameters. Consult the batch file
listing for further information.
5.5.0 AC_HUB.BAT
Description: This batch file is used in conjunction with a hub system
and a front end program like CMIDoor or ProLogon. This is the batch file
the front end should execute when a mailer is detected on the remote end.
5.6.0 CALLSEND.BAT
Description: This is the batch file nodes should execute when they wish
to call their hub and 'do a mail run'. The callsend batch file is
similar to the EV_NODE.BAT file, but it does not restart the BBS.
5.7.0 BUILD.BAT SystemId
Description: This batch file is used by a hub system to build packets for
all nodes connected. In the DC_HUB.BAT batch file, a build is performed
prior to waiting for node callers and after every node has connected.
This type of operation can by time consuming depending on the number of
nodes attached to the hub. The build sections of the DC_HUB.BAT and
AC_HUB.BAT are documented. If processing time becomes a concern the
build sections of these two batch files should be commented out and the
BUILD.BAT file should be executed at specific times throughout the day.
Parameters:
SystemId - the hub system id
5.8.0 PACKET.BAT SystemId RemoteId [PhoneNumber]
Description: Packet allows a sysop to create or add to a packet for a
node or a hub. This batch file is useful to create or initialize a
packet for a newly connected node.
Parameters:
SystemId - The local system id
RemoteId - The remote system id, the system for which the packet will be
build.
PhoneNumber - The phone number of the Remote system if the remote system
is a hub.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 16 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
Example:
PACKET CIS TECHNOID 222-1234
Creates or adds to the TECHNOID packet. TECHNOID is the hub in this
case and CIS is the node.
PAKCET TECHNOID CIS
Creates or adds to the CIS packet. CIS is the node in this case and
TECHNOID is the hub.
6.0.0 System Control File Reference
6.1.0 NETMAIL.SYS
Description: This file is the central control file for the HyperMail
system. MAKESYS.EXE creates this file. NETMAIL.SYS is the default name
for the system control file.
6.1.2 NETMAIL.LOG
Description: This is the log file for all system activity. This file
can grow large and should be purged on a regular basis. NETMAIL.LOG is
the default name for the log file and can be altered by using an
environment variable.
6.1.3 $SYSTEM$.PWD
Description: This is a system control file used for internal use. It
should not be deleted or altered.
6.1.4 $EMAIL and $EMAIL.NDX
Description: These files store the system message base. They are
not used by the system as of version 1.8.
6.1.5 CRC and CRC.IX
Description: These files store message CRC's for all extracted and
inserted messages. This file should never be deleted or modified. If the
CRC data base becomes too large for system constraints, use TRIMCRC.EXE to
pack the CRC data base.
6.1.6 SystemId.SYS
Description: These files (one for every node and hub attached to a
system) record a pointer variable for system purposes. This pointer
variable is the last generation of MP??????.PKT file added to a systems
archive.
7.0.0 Environment Variables
LOGFILE=FileName - Have programs write to different log files
SYSTEM=FileName - Have programs write to different NETMAIL.SYS files
CONFIG=FileName - Have programs read different configuration files
BAUD=xxx - Only callers that have a connect BPS rate GREATER than or
equal to xxx will be allowed into the system by HUBCOMM.EXE.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 17 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
Example: Have MSGTUILE.EXE write to a different log file.
SET LOGFILE=MSG.LOG
MSGUTIL /E
SET LOGFILE=
8.0.0 Required third party programs
The HyperMail system is an integrated mail network package. To maintain
flexibility and modularity the HyperMail system uses external protocols for
transferring files and external compression programs for efficiency. The
recommended standards are presented in the next section.
8.1.0 DSZ
The HyperMail system uses DSZ.EXE or DSZ.COM by Omen Technologies Inc.
for transferring files between systems.
8.2.0 PKZIP
The HyperMail system uses PKZIP.EXE and PKUNZIP.EXE by PKWARE Inc. for
compression of message files.
9.0.0 Conclusion
HyperMail is the easiest Networking mail package to install, hands down.
The maintenance and system operator duties are kept to a minimum by the
build in intelligence and modularity of the system. HyperMail runs by
itself which allow operators more time for meaningful activities.
9.1.0 Registration Information
In order to run HyperMail it is necessary to obtain a registration number
and a registration name. When you install HyperMail the Installation Tool
will generate a registration number based on your BBS name.
9.2.0 Disclaimer
Code Masters make no warranty of any kind, express or implied, including
without limitation, any warranties of merchantability and/or fitness for a
particular purpose. Code Masters shall not be liable for any damages,
whether direct, indirect, special or consequential arising from a failure
of this program to operate in the manner desired by the user. Code Masters
shall not be liable for any damage to data or property which may be caused
directly or indirectly by the use of this package.
IN NO EVENT WILL CODE MASTERS BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING
ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF YOUR USE OR INABILITY TO USE THE PACKAGE, OR FOR ANY CLAIM
BY ANY OTHER PARTY.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 18 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
9.3.0 Where to get more information
Support for HyperMail owners is available 24 hours a day via a 2 node
support Bulletin Board. Questions, comments and suggestions are
encouraged.
TechnoBabble BBS
(602) 650-1595
Other points of information:
David Cantere, HyperLink National Hub
Technoids Anonomous BBS, Phoenix AZ
(602) 786-9131 1200/2400/9600 - USR HST 14.4
(602) 899-4876 1200/2400 - Hayes
(602) 899-5317 Voice
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 19 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
Appendix A -Example: Steps to set up a 3 node network.
This appendix will describe the steps in detail required to setup a sample
3 node HyperMail network.
Step 1: Define the systems: Who will be the Hub? Who will be the node?
Define the system id's. The Hub will be named CENTRAL. There are two
nodes attached to CENTRAL, one called LEFT and one called RIGHT. The
system id's are arbitrary as long as they are unique.
In this sample system we will define on hub CENTRAL and two nodes LEFT and
RIGHT. This graph represents the network typlology:
CENTRAL
/ \
/ \
/ \
LEFT RIGHT
Step 2: Install HyperMail as defined in the installation part of the
manual. Now that the systems have been defined all systems should
install HyperMail.
Step 3: The Hub System Operator decides on what conferences are networked.
CENTRAL must decide which message areas will be on the network. Currently
CENTRAL has 5 message areas defined:
0 Main Board (Not allowed to echo)
1 Technical
2 Sysops
3 Race Cars
4 Networking
5 Unix
The CENTRAL system operator decides to 'echo' or network 4 conferences:
1 Technical
2 Sysops
4 Networking
5 Unix
The System Operator of CENTRAL must use ProSM (supplied with ProDOOR) to
change the ECHO conference flag for each of the network echos. This step
must be done or no messages will be echoed to the nodes.
The conference list for CENTRAL might now read:
0 Main Board (Not allowed to echo)
1 Technical (NETWORKED)
2 Sysops (NETWORKED)
3 Race Cars
4 Networking (NETWORKED)
5 Unix (NETWORKED)
Describing the conferences as being 'networked' or local allows the node
system operators to choose which conferences they can echo.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 20 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
Step 4: Nodes should create conference request files
LEFT has decided to echo conferences 1 and 2 from CENTRAL. The LEFT system
operator must create conferences using ProSM for these new message areas.
The ECHO flag must be set for each conference that is networked.
LEFT has now updated his conference list:
0 Main Board
1 Hardware Store
2 Technical (NETWORKED)
3 Guns
4 Sysops (NETWORKED)
LEFT must create a conference request file: CENTRAL.HUB and send this file
to CENTRAL. The configuration is explained in the configuration section of
the manual. Here is what the configuration file lookes like:
PASSWORD
2 1
4 2
LEFT sends the CENTRAL.HUB file to CENTRAL and then copies CENTRAL.HUB to
CENTRAL.NEW. Any additions or changes are made to the CENTRAL.NEW file.
The CENTRAL sysop receives the CENTRAL.HUB file and renames it to LEFT.NOD,
places it in the mail directory and executes the following programs:
MAKESYS CENTRAL LEFT
UPDATE
LEFT now executes the following programs in this sequence:
MAKESYS LEFT CENTRAL PhoneNumber
UPDATE
- A pointer file CENTRAL.PTR has now been created for node LEFT
RIGHT has decided to echo conferences 1,2,4, AND 5 from CENTRAL. The RIGHT
system operator must create conferences using ProSM for these new message
areas. The ECHO flag must be set for each conference that is networked.
RIGHT has now updated his conference list:
0 Main Board
1 Unix (NETWORKED)
2 Technical (NETWORKED)
3 Sysops (NETWORKED)
4 Networking (NETWORKED)
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 21 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
RIGHT must create a conference request file: CENTRAL.HUB and send this file
to CENTRAL. The configuration is explained in the configuration section of
the manual. Here is what the configuration file lookes like:
PASSWORD
1 5
2 1
3 2
4 4
RIGHT sends the CENTRAL.HUB file to CENTRAL and then copies CENTRAL.HUB to
CENTRAL.NEW. Any additions or changes are made to the CENTRAL.NEW file.
The CENTRAL sysop receives the CENTRAL.HUB file and renames it to
RIGHT.NOD, places it in the mail directory and executes the following
programs:
MAKESYS CENTRAL LEFT
UPDATE
RIGHT executes the following programs in this sequence:
MAKESYS RIGHT CENTRAL PhoneNumber
UPDATE
- A pointer file CENTRAL.PTR has now been created for node RIGHT.
Step 5: Setup a mail hour and the system events.
The CENTRAL system operator sets aside the time from 1:00 am to 2:00 am for
mail processing. He configures his BBS software to execute EV_HUB.BAT at
1:00 am.
The LEFT system operator is decides to call CENTRAL at 1:10 am. He
configures his BBS software to execute EV_NODE.BAT at 1:10 am.
The RIGHT system operator decides to call CENTRAL at 1:40 am. He
configures his BBS software to execute EV_NODE.BAT at 1:40 am.
Step 6: Test the setup.
At an agreed time all system operators agree to conference call each other.
CENTRAL executes EV_HUB.BAT. LEFT now executes EV_NODE.BAT and trys to
connect with CENTRAL. After LEFT has successfully completed his mail run,
RIGHT now executes EV_NODE.BAT and trys to connect with CENTRAL.
Step 7: Help!
If any errors occur during the connection process, double check the
existence of the LEFT.NOD and RIGHT.NOD files on CENTRAL and the
CENTRAL.HUB files on LEFT and RIGHT.
Be sure the passwords match and the files are named according to the
convention as described. If problems persist consult contact Code Masters
at the support number listed in the "Where to get more help section".
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 22 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
Appendix B - Using PCBoard as a front end.
NODECOMM.EXE has the ability to send a stream of text to an answering
system using the /F:FileName parameter. Included is the file MAILRUN.TXT
which can be used as the FileName parameter (i.e. /F:MAILRUN.TXT). Using
this feature NODECOMM.EXE can 'auto logon' to PCBoard, then PCBoard will
automatically open a door based on the callers security.
Below is the MAILRUN.TXT file:
N Q^NET MAIL MAILRUN^
Create a user called NET MAIL with the password MAILRUN and assign a
security level. Configure the DOORS.LST file to automatically execute the
AC_HUB.BAT file when a caller of this security is detected.
This will work for ANY number of nodes that call the system. They can use
the same logon id and password. HyperMail will identify each system when
they call.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 23 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
Appendix C - Upgrading from a previous version of HyperMail
Whenever a new version of HyperMail is installed it is essential the
installation program be executed. This ensures the proper configuration
files and batch files are created in accordance with the supported version.
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 24 -
CMI HyperMail Documentation
Version 1.8 GR (General Release) !ShareWare!
┌─────────────────────────────────────────────────────────┐
│ C M I H y p e r M a i l O r d e r F o r m ├─┐
└─┬───────────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────┘
=============================================================
Make Checks payable to: Andrew Woodward
Address: PO Box 24991
Tempe, AZ 85285-4991
=============================================================
Your Name ____________________________________________
Address ____________________________________________
City, State Zip ____________________________________________
Voice Phone ____________________________________________
** Be specific when listing your BBS name. It is your registration key.
Uppercase and lower case letters will generate a different serial
number.
BBS Name ____________________________________________
BBS Phone ____________________________________________
HyperMail System Id ┌─┬─┬─┬─┬─┬─┬─┬─┐
Valid DOS FileName: │ │ │ │ │ │ │ │ │
(8 characters or less) └─┴─┴─┴─┴─┴─┴─┴─┘
┌───────────────────────┬──────────┬───────────┬────────────┐
│ │ Price │ Quantity │ Totals │
├───────────────────────┼──────────┼───────────┼────────────┤
│ HyperMail Package │ $50.00 │ │ │
└───────────────────────┴──────────┴───────────┼────────────┤
Amount Enclosed $│ │
└────────────┘
Thanks!
(c) 1989, 1990, 1991 by Code Masters, Inc.
- Page 25 -